Skip to main content

How to use Embed link of Dataset

This Document Contains information about Embed dataset feature in OPNBI Application. Using Embed link of dataset, user can get the data of this dataset and use it in any external application using REST Request.

Objective​

Objective of this document is to Demonstrate how to access the data of Dataset resides in OPNBI in to External Application using External Embed link.

Prerequisites​

In order get dataset data using embed link user should have below components;

  1. Any existing dataset
  2. Postman Tool to send and get Rest Request responce

Skill Required​

User should have basic knowlage of Postman tool.

Use case​

Consider OPNBI is used in XYZ company, User has created one dataset inside OPNBI and they are using this dataset in multiple dashboards. Company need this same data to be used in their external web application to display for different purpose. One way they can get the data from writing same logic in SQL and fetch from there directly. in this case, they need to depends upon IT tem who can write query for them. In second way, User can use same data available in OPNBI dataset by just calling embed link of dataset from front end code. User no longer needed to rely on IT team to write queries. Also, using dataset embed, user can fetch data for different user by just changing parameters.

Steps to Follow​

Here we will show steps need to follow to generate and use Dataset embed link.

  1. Login to OPNBI Application with valid credentials

  2. Go to hamburger menu Docusaurus Slash Introduction > MasterData

  3. Click on Dataset section to go to dataset grid view

Docusaurus Slash Introduction

  1. select a dataset which you want to embed. Here we are taking customers dataset for demo purpose.

  2. Right click on it and you can see embed option available in context menu

Docusaurus Slash Introduction

  1. Click on this embed option and embed link window will be open

Docusaurus Slash Introduction

  1. In this window, keep everyting as it is and click on generate button to generate external embed link

Docusaurus Slash Introduction

  1. Scroll down and you can see code snippets in External Embed option

Docusaurus Slash Introduction

  1. Copy this code and place it in any text editor tool like notepad

  2. Open postman, create new http request. Keep request type GET

  • Click on File > New and select HTTP Request option

Docusaurus Slash Introduction

  1. Copy URL from notepad, and place this URL in Request field of postman

Docusaurus Slash Introduction

  1. Go to body option just below of URL you have pasted, select raw option and from dropdown select JSON and paste body section with curly brackets inside Body section of postman

Docusaurus Slash Introduction

  1. Now click on send button to send request, and if all details provided are valid, you can see dataset data in responce tab. Responce will be in form of JSON.

Docusaurus Slash Introduction

  1. This is how you can get the dataset data using Dataset embed link

Now use this Rest Request smililarly to call rest request inside your application.